Reference / integration surface
Agent Relay API Reference
A retrieval-first reference for the repository’s public routes, message contracts, configuration, and integration boundaries.
No reference entries match this search and category. Try another category or reset the filter.
01 / Reading this reference
Evidence before convenience
This page separates a repository’s public contract from implementation detail. A route belongs in the endpoint reference only when it can be traced to an actual route declaration, server registration, exported callable, or documented interface. A message belongs only when its fields are visible in a type, schema, serializer, validator, or equivalent source. Configuration belongs only when the key, default, and precedence can be demonstrated.
Why the records are empty. The build input contains the repository URL but no source extract or indexed repository files. Publishing plausible-looking API details would create a dangerous integration reference. Use the upstream repository as the source of truth until the records below are populated from code.
Provenance rule: inferred behavior must be labelled as inferred; public contract and implementation detail must never be merged into one claim.
02 / Integration surface
Endpoint reference
Each endpoint record should answer the integration questions that matter at the call site: exact method or invocation, path or identifier, required and optional inputs, response shape, errors, and a smallest valid request.
03 / Data contract
Message reference
Message documentation should describe direction as well as shape: who creates the message, who consumes it, which fields are required, and how serialization or validation changes the wire representation.
04 / Runtime behavior
Configuration reference
A useful configuration record includes the exact key, accepted value shape, default, requiredness, loading location, precedence, and the subsystem affected. Similar-looking environment variables are not interchangeable without source evidence.
05 / Smallest working path
Examples and copyable calls
Examples should be synchronized with the corresponding endpoint and message record. A copied request is only useful when its command, headers, payload, and expected response are all grounded in the same implementation.
Unverified No executable example is shown yet. Fabricating a request would imply an endpoint and payload that have not been verified. Once the source is indexed, every block on this page can expose a copy button while preserving clean, line-number-free code.
publish only what the repository demonstrates
label inferred behavior explicitly
keep request, response, and message schema synchronized06 / Integration cautions
Errors, limits, and compatibility
These are the questions to resolve before production integration—not assumptions to hide in a reference.
Error semantics Unverified Verify thrown errors, returned errors, status mapping, and retry safety.
Trace the failure path from the public call into validation, transport, and response handling. Record whether the caller receives a structured error, an exception, a rejected promise, or a transport-level failure. Never turn an implementation-specific error string into a stable contract without evidence.
Limits and lifecycle Unverified Verify payload size, timeouts, concurrency, retries, and connection ownership.
Look for explicit limits in validators, server configuration, queue or relay handling, and tests. If no limit is enforced, say that no repository-level limit was found; do not convert a hosting default into an Agent Relay guarantee.
Compatibility boundary Unverified Distinguish public wire shape from private implementation detail.
Compare the exported interface with the code that consumes it. A renamed internal variable is usually not a breaking change; a changed serialized field, invocation identifier, or required configuration key can be. Link any compatibility claim to a source location or test.
07 / Continue
Put the contract in context
Use setup documentation to establish a working local environment, then use the architecture guide to understand where each public surface sits in the relay flow.